IApi.EnableShutdownHandler 方法

当 EtherCAT 连结被建立时，附上一个关闭处置器 (Shutdown Handler)。此方法可在 Windows 关闭或当机时，允许 KINGSTAR Runtime 继续执行。使用 EnableShutdownHandler 时，您的应用程式需使用 RTX64 的 RtAttachShutdownHandler 函式，以让应用程式在关闭模式中执行。

RtAttachShutdownHandler 是一个仅能用于 RTX64 应用程式的即时 (RT) 函式，因此，若要使用 EnableShutdownHandler，您须具备一个 RTX64 使用者应用程式。

组合： IntervalZero.KINGSTAR.Base.Api (于 IntervalZero.KINGSTAR.Base.dll) 版本：4.4.0.0

语法

KsError EnableShutdownHandler(
       bool Active
)

Function EnableShutdownHandler(
       Active As Boolean
) As KsError

参数

Active

型别：bool

true：启用关闭处置器；false：停用关闭处置器。预设为 false。

回传值

型别：KsError

方法的回传值。

备注

• 此方法须在 Create 或 CreateAsync 后及 Start 前呼叫。
• 欲解除电脑关闭模式，使用者应用程式应呼叫 Stop 以令 KS 终止其关闭处置器。

可用的 EtherCAT 状态

ecatOffline

范例

N/A

参见

IApi 介面

IntervalZero.KINGSTAR.Base.Api 命名空间